home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / src / Tools / vtcl / doc / AppInit.3 < prev    next >
Encoding:
Text File  |  1995-07-10  |  3.1 KB  |  76 lines
  1. '\"
  2. '\" Copyright (c) 1993 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/tcl/man/RCS/AppInit.3,v 1.2 93/06/07 15:11:46 ouster Exp $ SPRITE (Berkeley)
  22. '\" 
  23. '\"----------------------------------------------------------------------------
  24. '\"    @(#) AppInit.3 26.1 93/10/22 SCOINC
  25. '\"
  26. '\"     Copyright (C) The Santa Cruz Operation, 1992-1993.
  27. '\"     This Module contains Proprietary Information of
  28. '\"    The Santa Cruz Operation, and should be treated as Confidential.
  29. '\"----------------------------------------------------------------------------
  30. .so ../man.macros
  31. .HS Tcl_AppInit tclc 7.0
  32. .BS
  33. .SH NAME
  34. Tcl_AppInit \- Perform application-specific initialization
  35. .SH SYNOPSIS
  36. .nf
  37. \fB#include <tcl.h>\fR
  38. .sp
  39. \fBTcl_AppInit\fR(\fIinterp\fR)
  40. .SH ARGUMENTS
  41. .AS Tcl_Interp *interp
  42. .AP Tcl_Interp *interp in
  43. Interpreter for the application.
  44. .BE
  45.  
  46. .SH DESCRIPTION
  47. .PP
  48. \fBTcl_AppInit\fR is a procedure that is invoked by the main programs
  49. for Tcl applications such as \fBtclsh\fR and \fBwish\fR.
  50. Its purpose is to allow new Tcl applications to be created without
  51. modifying existing main programs such as those for \fBtclsh\fR
  52. and \fBwish\fR.
  53. To create a new application simply write a new version of
  54. \fBTcl_AppInit\fR to replace the default version provided by Tcl,
  55. then link your new \fBTcl_AppInit\fR with the Tcl library, which
  56. contains the main program from \fBtclsh\fR (be sure to specify the
  57. switch ``\fB\-u _main\fR'' to the linker to force it to use the
  58. version of \fBmain\fR from the Tcl library).
  59. .PP
  60. \fBTcl_AppInit\fR is invoked after other initialization in
  61. \fBmain\fR and before entering the main loop to process commands.
  62. Here are some examples of things that \fBTcl_AppInit\fR might do:
  63. .IP [1]
  64. Call initialization procedures for various packages used by
  65. the application.
  66. Each initialization procedure adds new commands to \fIinterp\fR
  67. for its package and performs other package-specific initialization.
  68. .IP [2]
  69. Process command-line arguments, which can be accessed from the
  70. Tcl variables \fBargv\fR and \fBargv0\fR in \fIinterp\fR.
  71. .IP [3]
  72. Invoke a startup script to initialize the application.
  73.  
  74. .SH KEYWORDS
  75. application, argument, command, initialization, interpreter
  76.